home *** CD-ROM | disk | FTP | other *** search
/ PC Direct 1995 May / PC Direct CD-ROM (May 1995).ISO / ipe / misc / btrieve / btrreq.exe / BTRREQ.TXT
Encoding:
Text File  |  1994-01-06  |  18.1 KB  |  458 lines
  1.  
  2.               NOVELL TECHNICAL INFORMATION DOCUMENT
  3.  
  4. TITLE:              Btrieve Requesters v6.1x
  5. DOCUMENT ID:        TID000065
  6. DOCUMENT REVISION:  B
  7. DATE:               06JAN94
  8. ALERT STATUS:       Yellow
  9. INFORMATION TYPE:   Issue
  10. README FOR:         BTRREQ.EXE
  11.  
  12. NOVELL PRODUCT and VERSION:
  13. NetWare Btrieve NLM 5.15
  14. NetWare Btrieve VAP 5.15
  15. NetWare Btrieve NLM 6.10
  16.  
  17. ABSTRACT:
  18.  
  19. BTR61.EXE contains the latest Btrieve requesters for use with the 5.x versions
  20. of the Btrieve VAP and NLM and the 6.x versions of the Btrieve NLM.  Included
  21. are the latest requesters for DOS (BREQUEST 6.10e), Windows, OS/2, and
  22. UnixWare workstations.
  23.  
  24. ──────────────────────────────────────────────────────────────────────────────
  25. DISCLAIMER
  26. THE ORIGIN OF THIS INFORMATION MAY BE INTERNAL OR EXTERNAL TO NOVELL.  NOVELL
  27. MAKES EVERY EFFORT WITHIN ITS MEANS TO VERIFY THIS INFORMATION.  HOWEVER, THE
  28. INFORMATION PROVIDED IN THIS DOCUMENT IS FOR YOUR INFORMATION ONLY.  NOVELL
  29. MAKES NO EXPLICIT OR IMPLIED CLAIMS TO THE VALIDITY OF THIS INFORMATION.
  30. ──────────────────────────────────────────────────────────────────────────────
  31.  
  32. ISSUE
  33.  
  34.      Contents
  35.      ========
  36.  
  37.           File Information
  38.           Installation & Compatibility
  39.           Upgrade File Descriptions
  40.           Using the Requesters
  41.           DOS Requester
  42.           OS/2 Requester
  43.           Windows Requester
  44.  
  45.  
  46.      File Information
  47.      ================
  48.  
  49.      Self-Extracting File Name:  BTRREQ.EXE     Revision:  B
  50.  
  51.      Files Included     Size     Date      Time
  52.  
  53.      \
  54.        BTRREQ.TXT         (This File)
  55.      \DOS\
  56.      BREQUEST.EXE      60746   12-09-93    9:13a
  57.      BREQUEST.MSG       1180   12-09-93    9:12a
  58.      BREQUTIL.EXE      29801   10-28-93    1:40p
  59.      BREQUTIL.MSG       1091   10-20-93    1:00p
  60.      \OS2\
  61.       NDBCNVT.EXE      18192   01-29-93    1:40p
  62.       NDBCOMM.DLL      20343   10-26-93    1:16p
  63.      BTRCALLS.DLL      17944   06-11-93    9:32a
  64.      NWLOCALE.DLL      34480   05-18-93    1:00p
  65.      \UNIXWARE\
  66.         LIBBTRV.A      21432   02-05-93    6:08p
  67.         LIBCOMM.A      19120   02-05-93    6:08p
  68.        LIBBTRV.SO      18268   02-05-93    6:08p
  69.        LIBCOMM.SO      18596   02-05-93    6:08p
  70.        UNXCBTRV.O       1420   11-30-92   11:40a
  71.       BTRUNIX.TXT      12231   06-24-93    2:16p
  72.      \WIN\
  73.         NOVDB.INI       2460   11-06-92   10:48a
  74.      NWLOCALE.DLL      38800   05-18-93    1:00p
  75.      WBTRCALL.DLL      13131   05-13-93    4:00p
  76.      WBTRVRES.DLL      22912   01-30-93   12:16p
  77.      WNDBCNVT.EXE      30926   01-30-93   12:08p
  78.  
  79.  
  80.      Installation & Compatibility
  81.      ============================
  82.  
  83.      The Btrieve 6.1x Requesters can be used with the following NLMs and VAPs:
  84.  
  85.           Btrieve NLM v5.15
  86.           Btrieve VAP v5.15
  87.           Btrieve NLM v6.0x
  88.           Btrieve NLM v6.1x
  89.  
  90.      To install the requesters, simply replace the existing requester with the
  91.      new requester contained with this update.
  92.  
  93.  
  94.      Upgrade File Descriptions
  95.      =========================
  96.  
  97.           BTRREQ.TXT     This README file
  98.  
  99.           - Files related to DOS workstation operations:
  100.  
  101.           BREQUEST.EXE   Btrieve Requester for DOS.
  102.  
  103.           BREQUEST.MSG   Message file for BREQUEST.EXE.
  104.  
  105.           BREQUTIL.EXE   Btrieve Requester utility that allows you to stop the
  106.                          Requester and to obtain the Requester's version
  107.                          number at a DOS workstation.
  108.  
  109.           BREQUTIL.MSG   Message file for BREQUTIL.EXE.
  110.  
  111.  
  112.           - Files related to Windows workstation operations:
  113.  
  114.           WBTRCALL.DLL   Btrieve Requester for Windows.
  115.  
  116.           WBTRVRES.DLL   Resource file for the Btrieve Windows Requester.
  117.  
  118.           WNDBCNVT.EXE   Windows Conversion utility that converts the
  119.                          client-based Btrieve DLL (WBTRCALL.DLL) to
  120.                          WBTRLOCL.DLL.
  121.  
  122.           NOVDB.INI      Btrieve initialization file for the Btrieve Windows
  123.                          Requester.
  124.  
  125.           NWLOCALE.DLL   National Language Support DLL for the NetWare v3.11
  126.                          environment. Note that the WIN and the OS2
  127.                          directories each contain a different NWLOCALE.DLL.
  128.  
  129.  
  130.           - Files related to OS/2 workstation operations:
  131.  
  132.           BTRCALLS.DLL   Btrieve Requester for OS/2.
  133.  
  134.           NDBCOMM.DLL    Communications handler for the Btrieve Requester for
  135.                          OS/2.
  136.  
  137.           NDBCNVT.EXE    OS/2 Conversion utility that converts the
  138.                          client-based Btrieve DLL (BTRCALLS.DLL) to
  139.                          BTRLOCL.DLL.
  140.  
  141.           NWLOCALE.DLL   National Language Support DLL for the NetWare v3.11
  142.                          environment. Note that the WIN and the OS2
  143.                          directories each contain a different NWLOCALE.DLL.
  144.  
  145.  
  146.           - Files related to UnixWare workstation operations:
  147.  
  148.           LIBBTRV.A      Archive Btrieve Interface Library.
  149.  
  150.           LIBCOMM.A      Archive Communications Interface Library.
  151.  
  152.           LIBBTRV.SO     Shared-object Btrieve Interface Library.
  153.  
  154.           LIBCOMM.SO     Shared-object Communications Interface Library.
  155.  
  156.           UNXCBTRV.O     C interface object file.
  157.  
  158.           BTRUNIX.TXT    Readme document that describes the Btrieve Requester
  159.                          for UnixWare.
  160.  
  161.  
  162.      Using the Requesters
  163.      ====================
  164.  
  165.  
  166.      DOS Requester
  167.      -------------
  168.  
  169.      You must load the Btrieve DOS Requester, BREQUEST.EXE, at a workstation
  170.      before that workstation can access network Btrieve files using the
  171.      Btrieve NLM. The DOS Requester loads into a DOS workstation's memory as a
  172.      Terminate and Stay Resident (TSR) program. You can access local as well
  173.      as remote files by running both client-based (local) Btrieve and the
  174.      Requester at your workstation.
  175.  
  176.  
  177.      DOS Requester Configuration Options
  178.  
  179.      There are two configuration options for the DOS Requester: Data Message
  180.      Length (/D) and Help (/?). Previous versions of Btrieve supported the /S
  181.      and /R options. Btrieve v6.x accepts the /S and /R options for backwards
  182.      compatibility, but otherwise ignores them.
  183.  
  184.           Data Message Length (/D)
  185.           Range: 532 through 57,000 bytes
  186.           Default: 4,096 bytes
  187.           Memory Required: 538 bytes + data message length
  188.  
  189.      This option specifies the length of the largest record you want to access
  190.      through Btrieve. (If you omit this option, the Requester uses the default
  191.      value, 4,096.) The Requester uses this value to calculate the length of
  192.      the data message buffer reserved for passing records between Btrieve and
  193.      your applications. The Requester maintains one copy of the data message
  194.      buffer.
  195.  
  196.      The value you enter here should not exceed the largest record size you
  197.      configure for Btrieve through the Setup utility since that is the maximum
  198.      message that BSPXCOM can receive.
  199.  
  200.      NOTE:     Specifying a higher value than you need for the /D option does
  201.                not improve performance.
  202.  
  203.      Help (/?)
  204.      The /? option lists the only other option that is used, /D, and mentions
  205.      that although the /S and /R options are for backwards compatibility,
  206.      Btrieve v6.x ignores them.
  207.  
  208.  
  209.      Btrieve Requester for DOS -- This Requester has three new configuration
  210.      options.  For detailed information about this Requester, refer to Chapter
  211.      4 in the "Btrieve Installation and Operation" manual.
  212.  
  213.      -    NetWare Runtime Server Support (/C) -- Enables or disables NetWare
  214.           Runtime support.
  215.  
  216.      -    DOS Session Load (/L) -- Allows you to load another instance of the
  217.           Btrieve DOS Requester even if it is already loaded. This option is
  218.           useful if you want to run Windows applications using the Btrieve DOS
  219.           Requester while running DOS VM applications that are also using the
  220.           Requester.
  221.  
  222.      -    Real-Time Data Compression (/O) -- Helps reduce network traffic by
  223.           reducing the number of packets required to complete a request to
  224.           Btrieve.
  225.  
  226.  
  227.      Loading the DOS Requester
  228.  
  229.      Load the DOS Requester at the workstation by entering the following
  230.      command:
  231.  
  232.           [path] BREQUEST [/D:dataMsgLength]
  233.  
  234.           path The pathname to the directory where the DOS Requester is
  235.                stored.  You can omit the pathname if the DOS Requester is
  236.                stored on the default drive or if it is located in a directory
  237.                in your search path.
  238.  
  239.      For example, if the Requester is on the default drive and you want to
  240.      specify a 2,048-byte data message length, enter BREQUEST /D:2048.
  241.  
  242.      NOTE:     The forward slash (/) before the configuration option is the
  243.                only valid character you can use. If you specify a dash (-) or
  244.                a backslash (\), the Requester may load improperly.
  245.  
  246.      To ensure that the DOS Requester is always loaded with the /D option set
  247.      to a particular value, place the BREQUEST command in the workstation's
  248.      AUTOEXEC.BAT file.
  249.  
  250.  
  251.      Unloading the DOS Requester
  252.  
  253.      At a DOS workstation, you can use two methods to unload the DOS
  254.      Requester:
  255.  
  256.      -    Your application can issue a Stop operation (Btrieve operation 25).
  257.  
  258.      -    You can issue the stop command in the BUTIL utility from the
  259.           workstation's command line.
  260.  
  261.  
  262.      OS/2 Requester
  263.      --------------
  264.  
  265.      The following files must be loaded in a directory listed in an OS/2
  266.      workstation's LIBPATH before a Btrieve application can access the network
  267.      from that workstation:
  268.  
  269.      BTRCALLS.DLL -  the Btrieve dynamic link Requester for OS/2 workstations.
  270.  
  271.      NDBCOMM.DLL  - the communications Requester for OS/2 workstations. 
  272.                     NDBCOMM.DLL provides the necessary data communications
  273.                     between the workstation and the Btrieve NLM.
  274.  
  275.      You can access local as well as remote files by running both client-based
  276.      (local) Btrieve and the Requester at your workstation. If you want to run
  277.      both client-based Btrieve and the Requester, you must use the OS/2
  278.      conversion utility (NDBCNVT.EXE) to convert BTRCALLS.DLL to BTRLOCL.DLL.
  279.      You must type NDBCNVT on the command line to use this utility. (By
  280.      default, the Requester and the client-based Btrieve have the same name.)
  281.  
  282.  
  283.      OS/2 Requester Configuration Options
  284.  
  285.      You are not required to specify any configuration options for the OS/2
  286.      Requester. Since the internal tables that control the options are not
  287.      fixed, the tables will grow as needed. However, if you prefer to set the
  288.      initial size of the tables, you can do so using the Data Message Length
  289.      (/D) and the Number of Servers (/S) options.
  290.  
  291.           Data Message Length (/D)
  292.           Range: 532 through 65,000 bytes
  293.           Default: 4,096 bytes
  294.           Memory Required: 538 bytes + data message length
  295.  
  296.      The /D option specifies the length of the largest record you want to
  297.      access through Btrieve. The OS/2 Requester uses this value to calculate
  298.      the length of the data message buffer reserved for passing records
  299.      between Btrieve and your applications. The Requester maintains one copy
  300.      of the data message buffer.
  301.  
  302.      The value you enter here should not exceed the value you specified for
  303.      the Largest Record Size configuration option in the Setup utility.  The
  304.      value for this option represents the maximum message length that BSPXCOM
  305.      can receive.
  306.  
  307.      NOTE:     Specifying a higher value than you need for the /D option does
  308.                not improve performance.
  309.  
  310.           Number of Servers (/S)
  311.           Range: 1 through 255
  312.           Default: 8
  313.           Memory Required: 27 bytes per server
  314.  
  315.      The /S option specifies the number of servers that have the Btrieve NLM
  316.      active on the network.
  317.  
  318.      NOTE:     The forward slash (/) before the configuration option is the
  319.                only valid character you can use. If you specify a dash (-) or
  320.                a backslash (\), the Requester may load improperly.
  321.  
  322.  
  323.      Btrieve Requester for OS/2 -- This Requester also provides Runtime Server
  324.      support.  For detailed information about the Btrieve OS/2 Requester,
  325.      refer to Chapter 4 in the "Btrieve Installation and Operation" manual.
  326.  
  327.  
  328.      Configuring the OS/2 Requester
  329.  
  330.      Set the Requester configuration options using the following command:
  331.  
  332.           SET BRQPARMS=/D:dataMsgLength /S:numberOfServers
  333.  
  334.      Do not include a space between BRQPARMS and the equal sign. You can,
  335.      however, insert a space between each configuration option you specify.
  336.  
  337.  
  338.      Loading the OS/2 Requester
  339.  
  340.      An application may load the Btrieve for OS/2 Requester in one of the
  341.      following two ways:
  342.  
  343.      Implicitly - Your application can implicitly load the OS/2 Requester by
  344.      either linking with the import library BTRCALLS.LIB or by specifying
  345.      imported functions in the application definition file. If your
  346.      application uses this method, the operating system loads the OS/2
  347.      Requester automatically when the application is started.
  348.  
  349.      Explicitly - Your application can load the OS/2 Requester explicitly
  350.      using the operating system API functions. When the application loads the
  351.      Requester explicitly, the operating system does not load the OS/2
  352.      Requester until notified to do so.
  353.  
  354.  
  355.      Unloading the OS/2 Requester
  356.  
  357.      At an OS/2 workstation, the operating system removes the dynamic link
  358.      routines from memory when the application terminates or when the
  359.      application explicitly unloads the OS/2 Requester using the operating
  360.      system API.
  361.  
  362.      Logging out of one or more servers from a workstation does not close
  363.      Btrieve files or terminate the Btrieve SPX connection to the server.  To
  364.      close files and terminate the connection, you must either issue a STOP
  365.      command or reboot the server.
  366.  
  367.  
  368.      Windows Requester
  369.      -----------------
  370.  
  371.      In the Windows environment, you must load the DOS Requester,
  372.      BREQUEST.EXE, before starting Windows. Windows-based Btrieve applications
  373.      access the Requester by means of a DLL, WBTRCALL.DLL, which uses the DOS
  374.      Protected Mode Interface (DPMI) that Windows provides.
  375.  
  376.      The Windows Requester (that is, WBTRCALL.DLL) is the Btrieve interface
  377.      DLL for Windows v3.x. The DLL provides the same API as client-based
  378.      Btrieve and requires no modification to the application.
  379.  
  380.      You can access local as well as remote files by running both client-based
  381.      (local) Btrieve and the Requester at your workstation. If you want to run
  382.      both client-based Btrieve and the Requester, you must run the Windows
  383.      Conversion utility (WNDBCNVT.EXE) to convert WBTRCALL.DLL to
  384.      WBTRLOCL.DLL.  You must type WNDBCNVT on the command line to use this
  385.      utility.
  386.  
  387.      Windows Requester Configuration Options
  388.  
  389.      The following list describes the available configuration options for the
  390.      Windows Requester. These options should be specified in the NOVDB.INI
  391.      file under [brequestDPMI].
  392.  
  393.      NOVDB.INI is the Novell initialization file for the Windows Requester.
  394.  
  395.      Tasks = #                Specifies how many concurrent tasks may use the
  396.                               Windows Requester. The default value for this
  397.                               configuration option is 10.
  398.  
  399.      Local = Yes/No           Instructs the Windows Requester to use
  400.                               client-based Btrieve for accessing files
  401.                               locally. The default value for this
  402.                               configuration option is No.
  403.  
  404.      Chkparms = Yes/No        Instructs the Windows Requester to validate
  405.                               pointers passed to it. You should use this
  406.                               option only during development. The default
  407.                               value for this configuration option is No.
  408.  
  409.      Free Memory = Yes/No     Allocates and frees real-mode memory on each
  410.                               request. The Windows Requester uses a buffer of
  411.                               real-mode memory to communicate with the DOS
  412.                               Requester. Since real-mode memory is a scarce
  413.                               resource in Windows, your application should not
  414.                               retain it long term.The default value for this
  415.                               configuration option is No.
  416.  
  417.      NOTE:     Specifying Yes to the Free Memory option degrades performance.
  418.  
  419.  
  420.      Loading the Windows Requester
  421.  
  422.      The DOS Requester must be loaded before the Windows Requester can load. 
  423.      An application may load the Windows Requester in one of the following two
  424.      ways:
  425.  
  426.      Implicitly - Your application can implicitly load the Btrieve Requester
  427.      by either linking with the import library WBTRCALL.LIB or by specifying
  428.      imported functions in the application definition file. When an
  429.      application loads a DLL implicitly, the operating system automatically
  430.      loads the DLL when the application is started.
  431.  
  432.      Explicitly - Your application may load the Windows Requester explicitly
  433.      using the operating system API functions. The operating system does not
  434.      load the DLL until notified to do so.
  435.  
  436.  
  437.      Unloading the Windows Requester
  438.  
  439.      At a Windows workstation, the operating system removes the dynamic link
  440.      routines from memory when the application terminates or when the
  441.      application explicitly unloads the DLLs using the operating system API.
  442.  
  443.  
  444.      NOTE:     Logging out of one or more servers from a workstation does not
  445.                close Btrieve files or terminate the Btrieve SPX connection to
  446.                the server. To close files and terminate the connection, you
  447.                must either issue a STOP command or reboot the server. A Reset
  448.                operation does not terminate the SPX connection.
  449.  
  450.  
  451.      UnixWare Requester
  452.      ------------------
  453.      For infomormation regarding the Btrieve UnixWare requester, see the file
  454.      BTRUNX.TXT.
  455.  
  456. ** End of BTRREQ.TXT **
  457.  
  458.